[DOC-14129]: Magma Compaction rate limiter documentation#4122
Open
RayOffiah wants to merge 6 commits into
Open
[DOC-14129]: Magma Compaction rate limiter documentation#4122RayOffiah wants to merge 6 commits into
RayOffiah wants to merge 6 commits into
Conversation
Added page detailing REST call for magma compaction. Update menu navigation and index page. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
There was a problem hiding this comment.
Pull request overview
Adds REST API documentation for configuring Magma compaction rate limiting and exposes the page through the REST API navigation and memory/storage API index.
Changes:
- Added a new Magma Compaction Rate Limiting REST API page with settings, endpoints, and examples.
- Added the new page to the Memory and Storage API navigation.
- Added GET/POST endpoint entries to the memory and storage REST API table.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
modules/ROOT/nav.adoc |
Adds the new REST API page to the Memory and Storage API nav. |
modules/rest-api/partials/rest-memory-and-storage-table.adoc |
Lists the new Magma compaction rate limiting endpoint entries. |
modules/rest-api/pages/rest-magma-compaction-rate-limiting.adoc |
Documents the Magma compaction rate limiting settings and examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Changes made following co-pilot review. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Changes made following co-pilot review. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
ggray-cb
approved these changes
May 27, 2026
Contributor
ggray-cb
left a comment
ggray-cb
left a comment
There was a problem hiding this comment.
Have one question/suggestion on adding info about when these limits should be enabled. Otherwise, looks good.
| Use these API calls to set the rate limit (in bytes per second). | ||
| This setting is a global rate limit for the Memcached process shared across buckets. | ||
| The strategy for this rate limiting is to set the block waiting time on the compaction threads to maintain the specified limits. | ||
|
|
Contributor
There was a problem hiding this comment.
Is there any guidance we can give for customers as to when they should enable rate limiting? It seems off by default, so I assume they would only enable it if they wre seeing some sort of issue?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added page detailing REST call for Magma limit rate for compaction.
preview
Preview URL:
https://preview.docs-test.couchbase.com/docs-server-DOC-14129--8.1--Magma-Compaction-rate-limiter-documentation/server/current/rest-api/rest-magma-compaction-rate-limiting.html
You will need the Docs Team credentials on Confluence.